<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: PhyToMacControlInfo Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00177.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">PhyToMacControlInfo Class Reference<div class="ingroups"><a class="el" href="a00510.html">phyLayer - physical layer modules</a> &#124; <a class="el" href="a00509.html">macLayer - MAC layer modules</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="PhyToMacControlInfo" -->
<p>Controlinfo for packets which are send from Physical layer to the MAC layer.  
 <a href="a00177.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00301_source.html">PhyToMacControlInfo.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PhyToMacControlInfo:</div>
<div class="dyncontent">
<div class="center"><img src="a00942.png" border="0" usemap="#PhyToMacControlInfo_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00943.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a8e9300c49e9f955c4b5333da109143d4">PhyToMacControlInfo</a> (<a class="el" href="a00075.html">DeciderResult</a> *<a class="el" href="a00177.html#a1dc106d6290a2f4f18b4281e14077545">result</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the <a class="el" href="a00177.html" title="Controlinfo for packets which are send from Physical layer to the MAC layer.">PhyToMacControlInfo</a> with the passed <a class="el" href="a00075.html" title="A class to represent the result of a processed packet (that is not noise) by the Decider.">DeciderResult</a>.  <a href="#a8e9300c49e9f955c4b5333da109143d4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b56a9f0cf2b87496f6d19df98216bf5"></a><!-- doxytag: member="PhyToMacControlInfo::~PhyToMacControlInfo" ref="a5b56a9f0cf2b87496f6d19df98216bf5" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a5b56a9f0cf2b87496f6d19df98216bf5">~PhyToMacControlInfo</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clean up the <a class="el" href="a00075.html" title="A class to represent the result of a processed packet (that is not noise) by the Decider.">DeciderResult</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a695fcb4091796018a3315486acafc9b0"></a><!-- doxytag: member="PhyToMacControlInfo::getDeciderResult" ref="a695fcb4091796018a3315486acafc9b0" args="() const " -->
<a class="el" href="a00075.html">DeciderResult</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a695fcb4091796018a3315486acafc9b0">getDeciderResult</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the result of the evaluation of the <a class="el" href="a00070.html" title="The basic Decider class.">Decider</a>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static cObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a7d5a61c8f8a55edd3ea9e7d8195543ef">setControlInfo</a> (cMessage *const pMsg, <a class="el" href="a00075.html">DeciderResult</a> *const pDeciderResult)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches a "control info" structure (object) to the message pMsg.  <a href="#a7d5a61c8f8a55edd3ea9e7d8195543ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f35582c0a725032bd6ad7bae3d73367"></a><!-- doxytag: member="PhyToMacControlInfo::getDeciderResult" ref="a8f35582c0a725032bd6ad7bae3d73367" args="(cMessage *const pMsg)" -->
static <a class="el" href="a00075.html">DeciderResult</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a8f35582c0a725032bd6ad7bae3d73367">getDeciderResult</a> (cMessage *const pMsg)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">extracts the decider result from message "control info". <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0da48a989110f23b214f0fd8a2952333"></a><!-- doxytag: member="PhyToMacControlInfo::getDeciderResultFromControlInfo" ref="a0da48a989110f23b214f0fd8a2952333" args="(cObject *const pCtrlInfo)" -->
static <a class="el" href="a00075.html">DeciderResult</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a0da48a989110f23b214f0fd8a2952333">getDeciderResultFromControlInfo</a> (cObject *const pCtrlInfo)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">extracts the decider result from message "control info". <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00075.html">DeciderResult</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a1dc106d6290a2f4f18b4281e14077545">result</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae76095ce43562a4d55d1c9f39cc671e6"></a><!-- doxytag: member="PhyToMacControlInfo::PhyToMacControlInfo" ref="ae76095ce43562a4d55d1c9f39cc671e6" args="(const PhyToMacControlInfo &amp;)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#ae76095ce43562a4d55d1c9f39cc671e6">PhyToMacControlInfo</a> (const <a class="el" href="a00177.html">PhyToMacControlInfo</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor is not allowed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a463c3368fd0aff41e4f644177b110c80"></a><!-- doxytag: member="PhyToMacControlInfo::operator=" ref="a463c3368fd0aff41e4f644177b110c80" args="(const PhyToMacControlInfo &amp;)" -->
<a class="el" href="a00177.html">PhyToMacControlInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a463c3368fd0aff41e4f644177b110c80">operator=</a> (const <a class="el" href="a00177.html">PhyToMacControlInfo</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator is not allowed. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Controlinfo for packets which are send from Physical layer to the MAC layer. </p>
<p>The ControlInfo contains the the <a class="el" href="a00075.html" title="A class to represent the result of a processed packet (that is not noise) by the Decider.">DeciderResult</a> of the <a class="el" href="a00070.html" title="The basic Decider class.">Decider</a>. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8e9300c49e9f955c4b5333da109143d4"></a><!-- doxytag: member="PhyToMacControlInfo::PhyToMacControlInfo" ref="a8e9300c49e9f955c4b5333da109143d4" args="(DeciderResult *result)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PhyToMacControlInfo::PhyToMacControlInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00075.html">DeciderResult</a> *&#160;</td>
          <td class="paramname"><em>result</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the <a class="el" href="a00177.html" title="Controlinfo for packets which are send from Physical layer to the MAC layer.">PhyToMacControlInfo</a> with the passed <a class="el" href="a00075.html" title="A class to represent the result of a processed packet (that is not noise) by the Decider.">DeciderResult</a>. </p>
<p>NOTE: <a class="el" href="a00177.html" title="Controlinfo for packets which are send from Physical layer to the MAC layer.">PhyToMacControlInfo</a> takes ownership of the passed DeciderResult! </p>
<div class="fragment"><pre class="fragment">                                            :
    <a class="code" href="a00177.html#a1dc106d6290a2f4f18b4281e14077545">result</a>(result) {}
</pre></div>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d5a61c8f8a55edd3ea9e7d8195543ef"></a><!-- doxytag: member="PhyToMacControlInfo::setControlInfo" ref="a7d5a61c8f8a55edd3ea9e7d8195543ef" args="(cMessage *const pMsg, DeciderResult *const pDeciderResult)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static cObject* PhyToMacControlInfo::setControlInfo </td>
          <td>(</td>
          <td class="paramtype">cMessage *const&#160;</td>
          <td class="paramname"><em>pMsg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00075.html">DeciderResult</a> *const&#160;</td>
          <td class="paramname"><em>pDeciderResult</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Attaches a "control info" structure (object) to the message pMsg. </p>
<p>This is most useful when passing packets between protocol layers of a protocol stack, the control info will contain the decider result.</p>
<p>The "control info" object will be deleted when the message is deleted. Only one "control info" structure can be attached (the second setL3ToL2ControlInfo() call throws an error).</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pMsg</td><td>The message where the "control info" shall be attached. </td></tr>
    <tr><td class="paramname">pDeciderResult</td><td>The decider results. </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="a00020.html#a6ff53fb85a926f2d6bdf8dd9164ee0c7">BaseDecider::processSignalEnd()</a>, and <a class="el" href="a00029.html#af629dfbac6c68d0310ed91a7520c7ab2">BasePhyLayer::setUpControlInfo()</a>.</p>
<div class="fragment"><pre class="fragment">                                                                                              {
      <a class="code" href="a00177.html" title="Controlinfo for packets which are send from Physical layer to the MAC layer.">PhyToMacControlInfo</a> *<span class="keyword">const</span> cCtrlInfo = <span class="keyword">new</span> <a class="code" href="a00177.html#ae76095ce43562a4d55d1c9f39cc671e6" title="Copy constructor is not allowed.">PhyToMacControlInfo</a>(pDeciderResult);
      pMsg-&gt;setControlInfo(cCtrlInfo);

      <span class="keywordflow">return</span> cCtrlInfo;
    }
</pre></div>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1dc106d6290a2f4f18b4281e14077545"></a><!-- doxytag: member="PhyToMacControlInfo::result" ref="a1dc106d6290a2f4f18b4281e14077545" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00075.html">DeciderResult</a>* <a class="el" href="a00177.html#a1dc106d6290a2f4f18b4281e14077545">PhyToMacControlInfo::result</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The result of the decider evaluation. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/<a class="el" href="a00301_source.html">PhyToMacControlInfo.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00177.html">PhyToMacControlInfo</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:33 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
